chore: add react native remark link #918
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Yiwei Gong <[email protected]>
github-actions
bot
added
👋 phase/new
Signed-off-by: Yiwei Gong <[email protected]>
Signed-off-by: Yiwei Gong <[email protected]>
There was a problem hiding this comment.
Thanks for sharing @imwithye!
Looking at https://www.npmjs.com/package/react-native-remark and https://github.com/imwithye/react-native-remark/
A few things:
- The package isn't 1.0 (stable) yet, it is at 0.10.0 at the time of writing. I'm not comfortable recommending an unstable plugin (source: https://www.npmjs.com/package/react-native-remark)
- There are no tests for the package to make sure it works https://github.com/imwithye/react-native-remark/blob/53e3d9fe325d9775c72cc44ca85392d57bc6f060/package.json#L11
- Types that are required by the type definitions are listed as dev dependencies, which will cause some package managers (newer yarn and pnpm) to fail https://github.com/imwithye/react-native-remark/blob/53e3d9fe325d9775c72cc44ca85392d57bc6f060/package.json#L45
- The docs don't describe what the option this plugin accepts are https://github.com/imwithye/react-native-remark/tree/main?tab=readme-ov-file#usage
- The lint job doesn't lint check the code https://github.com/imwithye/react-native-remark/blob/53e3d9fe325d9775c72cc44ca85392d57bc6f060/.github/workflows/lint-pr.yml#L14
- The release doesn't generate a provenance statement https://github.com/imwithye/react-native-remark/blob/53e3d9fe325d9775c72cc44ca85392d57bc6f060/.github/workflows/release.yml#L31 https://docs.npmjs.com/generating-provenance-statements
- The type of the package is listed as module https://github.com/imwithye/react-native-remark/blob/53e3d9fe325d9775c72cc44ca85392d57bc6f060/package.json#L6 but the build is not configured to produce ESM https://github.com/imwithye/react-native-remark/blob/53e3d9fe325d9775c72cc44ca85392d57bc6f060/tsconfig.json#L4 for safely publishing it should be
node16,node18, ornodenexthttps://www.typescriptlang.org/tsconfig/#module - There are no docs on what flavor(s) of markdown are supported. Commonmark is the default of react-markdown. I also see GFM as a dependency https://github.com/imwithye/react-native-remark/blob/53e3d9fe325d9775c72cc44ca85392d57bc6f060/package.json#L33, any others? (Directive, mdx, frontmatter, etc)
|
Thank you very much! Your advice worth a lot! I will update my repo based your suggestions |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Initial checklist
Description of changes
Add related link to react-native-remark. I believe many developers are looking for a good solution for using remark with React Native, but existing options are limited. I created a library to fill this gap, and I think it would be helpful to include it as a related link. Thank you!